Add example Phoenix application #1948
Conversation
|
Awesome! Can you add a note/section to the Phoenix docs linking to and flagging up this example? |
magnetised
force-pushed
the
magnetised/add-phoenix-example
branch
from
ce1e6c3
to
182ec74
Compare
✅ Deploy Preview for electric-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
magnetised
force-pushed
the
magnetised/add-phoenix-example
branch
from
ada8941
to
17c1d83
Compare
|
@magnetised nice, ta. Two niggly suggestions:
So make it a: ## Examples
### electric-phoenix
...
<HelpWanted ...So we can add multiple examples over time. Ideally with some description of what the example shows (i.e.: the scope of the integration / functionality). As per https://electric-sql.com/docs/integrations/next#examples (but actually up a heading level). |
website/docs/integrations/phoenix.md
Outdated
| ### electric-phoenix | ||
|
|
||
| See the | ||
| [elixir-phoenix example](https://github.com/electric-sql/electric/tree/main/examples/electric-phoenix) |
There was a problem hiding this comment.
Typo on the package name.
If the example is a LiveView example, perhaps we should rename it examples/phoenix-liveview? And then the description there and here, rather than "using Electric for cross-browser synchronisation" can be e.g.:
This is an example Phoenix LiveView application that uses
[`Electric.Phoenix.live_stream/4`](https://hexdocs.pm/electric_phoenix/Electric.Phoenix.html#live_stream/4)
to sync data from Postgres into a LiveView using
[Phoenix Streams](https://fly.io/phoenix-files/phoenix-dev-blog-streams/).
This keeps the LiveView automatically in-sync with Postgres, without having
to re-run queries or trigger any change handling yourself.
See the
[documentation](https://electric-sql.com/docs/integrations/phoenix#liveview-sync)
for more details.There was a problem hiding this comment.
@thruflo Better? b0f2a1e (#1948)
website/docs/integrations/phoenix.md
Outdated
| @@ -80,13 +80,22 @@ For more details and full documentation see [hexdocs.pm/electric_phoenix](https: | |||
|
|
|||
| ## Examples | |||
|
|
|||
| ### electric-phoenix | |||
| ### phoenix-liveview | |||
There was a problem hiding this comment.
Awesome, thanks :)
Just one more tiny thing (sorry!) is this heading can now be "Phoenix LiveView".
to avoid a release dependency loop
magnetised
force-pushed
the
magnetised/add-phoenix-example
branch
from
bf06a9e
to
2159108
Compare
magnetised
temporarily deployed
to
Pull request
GitHub Actions
Inactive
Examples |
| @@ -80,6 +80,25 @@ This makes your LiveView applications real-time. In fact, it allows you to build | |||
|
|
|||
| For more details and full documentation see [hexdocs.pm/electric_phoenix](https://hexdocs.pm/electric_phoenix). | |||
|
|
|||
| ## Examples | |||
There was a problem hiding this comment.
Just one thought here is it's probably worth also mentioning the Gatekeeper auth example here, as an example using the Plug, e.g.:
### Phoenix LiveView
... as is ...
### Gatekeeper Auth
The [gatekeeper-auth](https://github.com/electric-sql/electric/tree/main/examples/gatekeeper-auth) example also contains a Phoenix application that uses [Electric.Phoenix.Plug](#...) to authorize shape access and issue shape-scoped access tokens.
Plus update the gatekeeper-auth example to use the new Electric.Phoenix apis